<?xml version="1.0"?>
<doc>
    <assembly>
        <name>Microsoft.Hawaii.Speech.Client</name>
    </assembly>
    <members>
        <member name="T:Microsoft.Hawaii.Speech.Client.SpeechService">
            <summary>
            Helper class that provides access to the Speech-to-Text service.
            </summary>
        </member>
        <member name="F:Microsoft.Hawaii.Speech.Client.SpeechService.DefaultHostName">
            <summary>
            Specifies the default service host name. This will be used to create the service url.
            </summary>
        </member>
        <member name="F:Microsoft.Hawaii.Speech.Client.SpeechService.DefaultGrammar">
            <summary>
            Name of the default speech grammar.
            </summary>
        </member>
        <member name="F:Microsoft.Hawaii.Speech.Client.SpeechService.Signature">
            <summary>
            Specifies a signature for the REST methods that are part of the speech-to-text service.
            </summary>
        </member>
        <member name="F:Microsoft.Hawaii.Speech.Client.SpeechService.stagingConfigFileName">
            <summary>
            The name of the config file that indicates where the SpeechToText staging service is located.  Used only as a test hook.
            </summary>
        </member>
        <member name="F:Microsoft.Hawaii.Speech.Client.SpeechService.hostName">
            <summary>
            The service host name.  This is the private variable that is initialized on first
            access via the GetHostName() method.  If a config file is present to point to a
            staging server, that host will be stored.  Otherwise, the default is used.
            </summary>
        </member>
        <member name="F:Microsoft.Hawaii.Speech.Client.SpeechService.serviceScope">
            <summary>
            The service scope.  This is the private variable that is initialized on first
            access via the ServiceScope get accessor.  If a config file is present to point to a
            staging server, that host will be stored.  Otherwise, the default is used.
            </summary>
        </member>
        <member name="M:Microsoft.Hawaii.Speech.Client.SpeechService.GetGrammarsAsync(System.String,Microsoft.Hawaii.ServiceAgent{Microsoft.Hawaii.Speech.Client.SpeechServiceResult}.OnCompleteDelegate,System.Object)">
            <summary>
            Helper method to initiate the service call that retrieves all grammars available on the server.
            </summary>
            <param name="hawaiiAppId">Specifies the Hawaii Application Id.</param>
            <param name="onComplete">Specifies an "on complete" delegate handler.</param>
            <param name="stateObject">Specifies a user-defined object.</param>
        </member>
        <member name="M:Microsoft.Hawaii.Speech.Client.SpeechService.RecognizeSpeechAsync(System.String,System.String,System.Byte[],Microsoft.Hawaii.ServiceAgent{Microsoft.Hawaii.Speech.Client.SpeechServiceResult}.OnCompleteDelegate,System.Object)">
            <summary>
            Helper method to initiate the service call that executes the speech-to-text translation.
            </summary>
            <param name="hawaiiAppId">Specifies the Hawaii Application Id.</param>
            <param name="grammar">Specifies a grammar name.</param>
            <param name="speechBuffer">
            Specifies a buffer containing the audio data to be translated to text.
            The audio buffer should have the following characteristics:
            'SamplesPerSecond=16000', 'AudioBitsPerSample=16' and 'AudioChannel=Mono'.
            </param>
            <param name="onComplete">Specifies an "on complete" delegate handler.</param>
            <param name="stateObject">Specifies a user-defined object.</param>
        </member>
        <member name="M:Microsoft.Hawaii.Speech.Client.SpeechService.GetGrammarsAsync(Microsoft.Hawaii.ClientIdentity,Microsoft.Hawaii.ServiceAgent{Microsoft.Hawaii.Speech.Client.SpeechServiceResult}.OnCompleteDelegate,System.Object)">
            <summary>
            Helper method to initiate the service call that retrieves all grammars available on the server.
            </summary>
            <param name="clientIdentity">The hawaii client identity.</param>
            <param name="onComplete">Specifies an "on complete" delegate handler.</param>
            <param name="stateObject">Specifies a user-defined object.</param>
        </member>
        <member name="M:Microsoft.Hawaii.Speech.Client.SpeechService.RecognizeSpeechAsync(Microsoft.Hawaii.ClientIdentity,System.String,System.Byte[],Microsoft.Hawaii.ServiceAgent{Microsoft.Hawaii.Speech.Client.SpeechServiceResult}.OnCompleteDelegate,System.Object)">
            <summary>
            Helper method to initiate the service call that executes the speech-to-text translation.
            </summary>
            <param name="clientIdentity">The hawaii client identity.</param>
            <param name="grammar">Specifies a grammar name.</param>
            <param name="speechBuffer">
            Specifies a buffer containing the audio data to be translated to text.
            The audio buffer should have the following characteristics:
            'SamplesPerSecond=16000', 'AudioBitsPerSample=16' and 'AudioChannel=Mono'.
            </param>
            <param name="onComplete">Specifies an "on complete" delegate handler.</param>
            <param name="stateObject">Specifies a user-defined object.</param>
        </member>
        <member name="M:Microsoft.Hawaii.Speech.Client.SpeechService.GetHostName">
            <summary>
            Returns the Host Name to be used when accessing the service.  This will generally
            be the value specified in the DefaultHostName, but it can conditionally be set with
            the presence of a config file on first access.
            </summary>
            <returns>A string containing the host name of the service</returns>
        </member>
        <member name="P:Microsoft.Hawaii.Speech.Client.SpeechService.HostName">
            <summary>
            Gets the Host Name to be used when accessing the service.
            </summary>
        </member>
        <member name="P:Microsoft.Hawaii.Speech.Client.SpeechService.ServiceScope">
            <summary>
            Gets the service scope to be used when accessing the adm OAuth service.
            </summary>
        </member>
        <member name="T:Microsoft.Hawaii.Speech.Client.SpeechGrammarsAgent">
            <summary>
            This class provides helper methods used to communicate with the Hawaii Speech-to-Text service.
            It has helper methods for contacting Hawaii Speech-to-Text Service to receive all available grammars in the server. 
            Currently, only the 'Dictation' grammar is available for a general purpose speech-to-text translation.
            </summary>
        </member>
        <member name="M:Microsoft.Hawaii.Speech.Client.SpeechGrammarsAgent.#ctor(System.String,Microsoft.Hawaii.ClientIdentity)">
            <summary>
            Initializes a new instance of the SpeechGrammarsAgent class.
            </summary>
            <param name="hostName">Specifies a host name of the speech service.</param>
            <param name="clientIdentity">Specifies the client identity.</param>
        </member>
        <member name="M:Microsoft.Hawaii.Speech.Client.SpeechGrammarsAgent.#ctor(System.String,Microsoft.Hawaii.ClientIdentity,System.Object)">
            <summary>
            Initializes a new instance of the SpeechGrammarsAgent class.
            </summary>
            <param name="hostName">Specifies a host name of the speech service.</param>
            <param name="clientIdentity">Specifies the client identity.</param>
            <param name="stateObject">Specifies a user-defined object.</param>
        </member>
        <member name="M:Microsoft.Hawaii.Speech.Client.SpeechGrammarsAgent.ParseOutput(System.IO.Stream)">
            <summary>
            An overridden abstract method. This method is called after the response sent by the server is received by the client.
            speech service.
            </summary>
            <param name="responseStream">
            The response stream containing response data that is received from the server.
            </param>
        </member>
        <member name="M:Microsoft.Hawaii.Speech.Client.SpeechGrammarsAgent.CreateServiceUri(System.String)">
            <summary>
            It creates the service uri.
            </summary>
            <param name="hostName">Specifies a host name of the service.</param>
            <returns>A valid service uri object.</returns>
        </member>
        <member name="P:Microsoft.Hawaii.Speech.Client.SpeechGrammarsAgent.RequestContentType">
            <summary>
            An overriden property to set the request content type to be Json.
            </summary>
        </member>
        <member name="T:Microsoft.Hawaii.Speech.Client.SpeechResult">
            <summary>
            This class describes the result obtained after a Hawaii Speech-to-Text call.
            </summary>
        </member>
        <member name="M:Microsoft.Hawaii.Speech.Client.SpeechResult.#ctor">
            <summary>
            Initializes a new instance of the SpeechResult class.
            </summary>
        </member>
        <member name="P:Microsoft.Hawaii.Speech.Client.SpeechResult.InternalErrorMessage">
            <summary>
            Gets or sets the error message if an error occures during the Speech-to-Text translation.
            </summary>
        </member>
        <member name="P:Microsoft.Hawaii.Speech.Client.SpeechResult.Items">
            <summary>
            Gets or sets the list of items obtained after the speech-to-text translation. 
            </summary>
        </member>
        <member name="T:Microsoft.Hawaii.Speech.Client.SpeechServiceResult">
            <summary>
            This class represents the result of the Speec-to-Text processing.
            </summary>
        </member>
        <member name="P:Microsoft.Hawaii.Speech.Client.SpeechServiceResult.SpeechResult">
            <summary>
            Gets the result of the Speec-to-Text processing.
            </summary>
        </member>
        <member name="T:Microsoft.Hawaii.Speech.Client.SpeechRecognitionAgent">
            <summary>
            This class provides helper methods used to communicate with the Hawaii Speech-to-Text service.
            It has helper methods for contacting Hawaii Speech-to-Text Service to execute the speech-to-text translation.
            It accepts an audio stream as input, sends it to the speech service and receives a list of potential texts corresponding to the audio input.
            </summary>
        </member>
        <member name="M:Microsoft.Hawaii.Speech.Client.SpeechRecognitionAgent.#ctor(System.String,Microsoft.Hawaii.ClientIdentity,System.String,System.Byte[])">
            <summary>
            Initializes a new instance of the SpeechRecognitionAgent class.
            </summary>
            <param name="hostName">Specifies a host name of the speech service.</param>
            <param name="clientIdentity">Specifies the client identity.</param>
            <param name="grammar">Specifies a grammar name loaded in the server.</param>
            <param name="speechBuffer">
            Specifies a buffer containing the audio data to be translated to text.
            The audio buffer should have the following characteristics:
            'SamplesPerSecond=16000', 'AudioBitsPerSample=16' and 'AudioChannel=Mono'.
            </param>
        </member>
        <member name="M:Microsoft.Hawaii.Speech.Client.SpeechRecognitionAgent.#ctor(System.String,Microsoft.Hawaii.ClientIdentity,System.String,System.Byte[],System.Object)">
            <summary>
            Initializes a new instance of the SpeechRecognitionAgent class.
            </summary>
            <param name="hostName">Specifies a host name of the speech service.</param>
            <param name="clientIdentity">Specifies the client identity.</param>
            <param name="grammar">Specifies a grammar name loaded in the server.</param>
            <param name="speechBuffer">
            Specifies a buffer containing the audio data to be translated to text.
            The audio buffer should have the following characteristics:
            'SamplesPerSecond=16000', 'AudioBitsPerSample=16' and 'AudioChannel=Mono'.
            </param>
            <param name="stateObject">Specifies a user-defined object.</param>
        </member>
        <member name="M:Microsoft.Hawaii.Speech.Client.SpeechRecognitionAgent.GetPostData">
            <summary>
            An overridden abstract method. It provides the POST (as in Http POST) data that has to be sent to the service.
            This method will be called by the base class when it needs data during a Http POST method call.
            </summary>
            <returns>
            The POST data as an array of bytes.
            </returns>
        </member>
        <member name="M:Microsoft.Hawaii.Speech.Client.SpeechRecognitionAgent.ParseOutput(System.IO.Stream)">
            <summary>
            An overridden abstract method. This method is called after the response sent by the server is received by the client.
            </summary>
            <param name="responseStream">
            The response stream containing response data that is received from the server.
            </param>
        </member>
        <member name="M:Microsoft.Hawaii.Speech.Client.SpeechRecognitionAgent.OnCompleteRequest">
            <summary>
            An overriden method. 
            It is invoked after completing the service request. It does some processing of the Speech-to-Text service call result 
            and it calls the client's "on complete" callback method.
            </summary>
        </member>
        <member name="M:Microsoft.Hawaii.Speech.Client.SpeechRecognitionAgent.CreateServiceUri(System.String,System.String)">
            <summary>
            Method creates the service uri.
            </summary>
            <param name="hostName">Specifies a host name of the service.</param>
            <param name="grammar">Specifies a grammar name.</param>
            <returns>A valid service uri object.</returns>
        </member>
        <member name="P:Microsoft.Hawaii.Speech.Client.SpeechRecognitionAgent.SpeechBuffer">
            <summary>
            Gets the speech buffer to be translated to text. 
            The audio buffer should have the following characteristics:
            'SamplesPerSecond=16000', 'AudioBitsPerSample=16' and 'AudioChannel=Mono'.
            </summary>
        </member>
        <member name="P:Microsoft.Hawaii.Speech.Client.SpeechRecognitionAgent.RequestContentType">
            <summary>
            An overriden property to set the request content type to be Json.
            </summary>
        </member>
        <member name="T:Microsoft.Hawaii.Speech.Client.NamespaceDoc">
            <summary>
            The Microsoft.Hawaii.Speech.Client namespace contains classes for 
            sending audio information and receiving the textual representation 
            of that audio through the Hawaii Speech Service.
            </summary>
        </member>
    </members>
</doc>
